Skip to content

feat(new-webui): Add theme support with a toggle menu. - #935

Closed
junhaoliao wants to merge 2 commits into
mainfrom
antd-theme
Closed

feat(new-webui): Add theme support with a toggle menu.#935
junhaoliao wants to merge 2 commits into
mainfrom
antd-theme

Conversation

@junhaoliao

@junhaoliao junhaoliao commented May 28, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

  1. Add theme support.
    1. Persist theme mode with localStorage.
  2. Add a menu item in the sider menu for theme switching.
    image

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  1. Verified that theme mode switching by clicking the newly added menu item works.
  2. Verified that theme mode setting is persisted across page refreshes.
  3. Verified that the "System" theme mode works by changing the OS's theme mode between dark / light.

Summary by CodeRabbit

  • New Features
    • Introduced theme support with light, dark, and system modes, allowing users to toggle the app's appearance.
    • Added a theme toggle option in the sidebar menu for easy switching between theme modes.
  • Enhancements
    • Updated sidebar layout and styling for improved visual structure and usability.
    • Sidebar menu now highlights the current section based on navigation.
    • Increased sidebar width for better content display.
  • Chores
    • Added internal theme configuration and utilities to support dynamic theming.

@junhaoliao
junhaoliao requested a review from a team as a code owner May 28, 2025 20:45
@junhaoliao
junhaoliao requested a review from davemarco May 28, 2025 20:45
@coderabbitai

coderabbitai Bot commented May 28, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a theme management system to the log-viewer web UI, including a Zustand-based theme state store, Ant Design theme configuration, and a theme toggle menu item. The layout and sidebar are refactored to support the new theming, and new CSS classes are added to accommodate the updated sidebar structure.

Changes

File(s) Change Summary
AntdApp.tsx Wrapped the router with Ant Design ConfigProvider using a merged theme config and dynamic algorithm from theme store for contextual theming.
MainLayout.module.css Updated .mainLayout height/overflow, modified .siderLogo padding, and added new .siderContainer and .siderTopMenu classes for sidebar layout.
MainLayout.tsx Refactored sidebar: removed collapsed state, split menu into top/bottom sections, increased sidebar width, and integrated theme toggle menu item.
ThemeToggleMenuItem.tsx Added new component for toggling theme mode (system/dark/light) via menu item, updating theme state on click.
theme/index.tsx Added Ant Design theme config (THEME_CONFIG), and re-exported theme mode enum and theme state hook.
theme/themeStore.ts Introduced Zustand store (useThemeStore) for theme mode and algorithm, with persistence and custom merge logic.
theme/typings.ts Added and exported THEME_MODE enum for theme modes.
theme/utils.ts Added utility functions to determine Ant Design theme algorithm based on mode or system preference.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ThemeToggleMenuItem
    participant useThemeStore
    participant AntdApp (ConfigProvider)
    participant MainLayout

    User->>ThemeToggleMenuItem: Click theme toggle
    ThemeToggleMenuItem->>useThemeStore: setMode(nextMode)
    useThemeStore-->>ThemeToggleMenuItem: Update mode & algorithm
    useThemeStore-->>AntdApp (ConfigProvider): Provide updated algorithm
    AntdApp (ConfigProvider)-->>MainLayout: Render with new theme
    MainLayout-->>User: UI updates with new theme
Loading

Possibly related PRs

  • feat(webui): Adds a switch to enable new Ant Design webui and a basic menu. #791: The main PR builds upon the initial Ant Design web UI setup introduced in the retrieved PR by enhancing theming support and layout refinements, directly modifying the same AntdApp.tsx component and related UI structure.
  • feat(new-webui): Add support for page switching using react-router. #797: The main PR extends the theming support by wrapping the router with an Ant Design ConfigProvider and adds theme state management and toggle UI, while the retrieved PR introduces routing with react-router and refactors the layout to support page switching; both modify the AntdApp.tsx and MainLayout.tsx components to integrate routing but the main PR adds theming context around the router, showing a direct and strong connection at the component integration level.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e864329 and ff6bcb3.

📒 Files selected for processing (8)
  • components/log-viewer-webui/client/src/AntdApp.tsx (2 hunks)
  • components/log-viewer-webui/client/src/components/Layout/MainLayout.module.css (2 hunks)
  • components/log-viewer-webui/client/src/components/Layout/MainLayout.tsx (2 hunks)
  • components/log-viewer-webui/client/src/components/Layout/ThemeToggleMenuItem.tsx (1 hunks)
  • components/log-viewer-webui/client/src/theme/index.tsx (1 hunks)
  • components/log-viewer-webui/client/src/theme/themeStore.ts (1 hunks)
  • components/log-viewer-webui/client/src/theme/typings.ts (1 hunks)
  • components/log-viewer-webui/client/src/theme/utils.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@junhaoliao
junhaoliao requested a review from kirkrodrigues May 28, 2025 20:47
@junhaoliao

junhaoliao commented May 28, 2025

Copy link
Copy Markdown
Member Author

sorry wrong branch pushed

@junhaoliao junhaoliao closed this May 28, 2025
@junhaoliao
junhaoliao deleted the antd-theme branch May 28, 2025 20:49
@junhaoliao

junhaoliao commented May 28, 2025

Copy link
Copy Markdown
Member Author

replaced by #937

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davemarco davemarco Awaiting requested review from davemarco
@kirkrodrigues kirkrodrigues Awaiting requested review from kirkrodrigues

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@junhaoliao